home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / sflasten.zip / SFLASTEN.DOC < prev   
Text File  |  1991-10-22  |  8KB  |  172 lines
  1.                                SFLASTEN
  2.                           (SPITFIRE LAST TEN)
  3.                              Version 1.0
  4.                    Copyright (C) by Mike Woltz, 1991
  5.                          Buffalo Creek Software
  6.                               A Member Of 
  7.                 The Association Of Shareware Professionals
  8.     
  9.  
  10.     INTRODUCTION
  11.     ------------
  12.  
  13.        SFLASTEN is a utility written by Mike Woltz, author of SPITFIRE,
  14.     to generate a last ten callers display file for a SPITFIRE BBS.
  15.     SFLASTEN will create <filename>.BBS/CLR display files which lists
  16.     the last ten callers of the board.  The display files will look
  17.     similar to the below example...
  18.  
  19.          ┌───┐     ╒═══════════════════════════════╕     ┌───┐
  20.          │   │     │ SPITFIRE BBS Last Ten Callers │     │   │
  21.          └───┼─────┴───────────────────────────────┴─────┼───┘
  22.              │                                           │
  23.              │ Stan Kapala .............. 10-22-91 13:39 │
  24.              │ Tom Blalock .............. 10-22-91 13:35 │
  25.              │ Ira Lichtenstein ......... 10-22-91 13:34 │
  26.              │ Chuck Gilmore ............ 10-22-91 13:26 │
  27.              │ Walt Bush ................ 10-22-91 13:11 │
  28.              │ Frank Lech  .............. 10-22-91 13:01 │
  29.              │ Guy Rink ................. 10-22-91 12:53 │
  30.              │ Larry Miller ............. 10-22-91 12:34 │
  31.              │ Robert Arguello .......... 10-22-91 12:32 │
  32.              │ Frank Crispell ........... 10-22-91 12:17 │
  33.              │                                           │
  34.          ┌───┼───────────────────────────────────────────┼───┐
  35.          │   │                                           │   │
  36.          └───┘                                           └───┘
  37.  
  38.        SFLASTEN is extremely fast and the size of SFLASTEN.COM file is
  39.     very small (a big plus to all Sysops who are concerned about disk
  40.     space) because it is written in assembler language.
  41.     
  42.        SFLASTEN is not intended to undermine the use of any other utility
  43.     (there are several others) which performs basically the same task.
  44.  
  45.  
  46.     SETUP AND OPERATION AND COMMAND LINE PARAMETERS
  47.     -----------------------------------------------
  48.  
  49.        SFLASTEN must reside in the HOME directory of the SPITFIRE BBS.
  50.     SFLASTEN first reads SPITFIRE's SFNODE.DAT and then SFUSERS.DAT
  51.     file.  If either of these are not found, SFLASTEN will notify
  52.     the file was not found and halt operation.  SFLASTEN reads the
  53.     information in the SFUSERS.DAT file to determine the last ten
  54.     callers and creates both color and non-color display files listing
  55.     the board's last ten callers.
  56.     
  57.        SFLASTEN can be used by any combination of the following command
  58.     line parameters, however, the name of the file to be created is
  59.     required:
  60.     
  61.        Usage...
  62.        C>SFLASTEN WELCOME2 /SSL=xxx /P
  63.  
  64.        WELCOME2 = Display File Name ................. Required!
  65.        /SSL=xxx = Skip Security Level Equal To xxx .. Optional!
  66.        /P       = Pause Prompt Control Character .... Optional!
  67.     
  68.  
  69.        While SFLASTEN is designed to be used within SFINIT.BAT, it can
  70.     be executed either from the DOS prompt or as an event from your
  71.     SF.BAT file.  SFLASTEN uses a command line parameter which allows
  72.     you to specify the name of the display files to be generated.
  73.     Please note that the specified file name should NOT include a path
  74.     and a file extension since SPITFIRE automatically creates the display
  75.     files in your DISPLAY directory and automatically adds the extension
  76.     .BBS to the first created file and .CLR to the second created file.
  77.     Listed below is an example of a SFINIT.BAT file which could be used
  78.     to execute SFLASTEN between callers.
  79.  
  80.     @Echo Off
  81.     SFLASTEN WELCOME2 /SSL=999 /P
  82.     TYPE \SF\DISPLAY\WELCOME2.CLR
  83.     
  84.        Notice, no extension is used in the command line parameter.  If 
  85.     an extension is added, it is ignored and *.BBS\CLR files are created.
  86.     Further, please notice that no path is included with the file name.
  87.     In the event a path is entered on the command line, a file creation
  88.     error will occur.
  89.  
  90.        The /P parameter will cause SFLASTEN to place a ^E^P at the end
  91.     of each display file created.  SPITFIRE will cause the 'pause prompt'
  92.     to appear when the ^E^P is found in the created display files.
  93.  
  94.        The /SSL=xxx will cause SFLASTEN to ignore callers with a security
  95.     level of xxx.  For example, if /SSL=999 is used on the command line,
  96.     the any caller with a security level of 999 will not be included in
  97.     the created display files.
  98.  
  99.  
  100.     OPERATION ERRORS
  101.     ----------------
  102.    
  103.        If SFLASTEN is not executed from the directory in which 
  104.     SFUSERS.DAT resides, SFLASTEN will beep and give the following
  105.     error message: "SFNODE.DAT not found!".
  106.     
  107.        If you entered a path in the command line parameter
  108.     SFLASTEN will give an error message stating, "Error creating
  109.     <the path that you entered>".
  110.     
  111.  
  112.     SFLASTEN ON A MULTI-NODE SYSTEM
  113.     -------------------------------
  114.    
  115.        SFLASTEN is fully compatible for operation on a multi-node BBS.
  116.     It automatically handles any file locking and file sharing 
  117.     required during the execution.   
  118.  
  119.  
  120.  
  121.     DISTRIBUTION
  122.     ------------
  123.  
  124.        SFLASTEN is distributed under the shareware concept.  You are
  125.     free to distribute the SFLASTEN program as long as it remains
  126.     unmodified and no fee is charged.  If you continue to use this 
  127.     program after an adequate evaluation period, then a fee is required.
  128.     A $1.00 fee is required of registered SPITFIRE sysops and a 
  129.     $ 5.00 fee is required of those who are not registered users
  130.     of SPITFIRE. 
  131.  
  132.         Those registering SFLASTEN, can for a $5 fee, have a special
  133.     version compiled so that the display file header will list the name
  134.     of the BBS rather than the default 'SPITFIRE BBS Last Ten Callers'
  135.     header and so that the color of the .CLR file can be designated.
  136.     Listed below is the default display file header and a sample of
  137.     a header which could be created by a specially compiled copy of
  138.     SFLASTEN.
  139.  
  140.          ┌───┐     ╒═══════════════════════════════╕     ┌───┐
  141.          │   │     │ SPITFIRE BBS Last Ten Callers │     │   │
  142.          └───┼─────┴───────────────────────────────┴─────┼───┘
  143.              │                                           │
  144.              │ Stan Kapala .............. 10-22-91 13:39 │
  145.  
  146.          ┌───┐     ╒═══════════════════════════════╕     ┌───┐
  147.          │   │     │ Solid Rock's Last Ten Callers │     │   │
  148.          └───┼─────┴───────────────────────────────┴─────┼───┘
  149.              │                                           │
  150.              │ Stan Kapala .............. 10-22-91 13:39 │
  151.  
  152.        In the event you decide to have a copy of SFLASTEN compiled
  153.     specifically for you ($5.00 fee), then the name you want in
  154.     the header must be 30 characters or less.
  155.  
  156.     DISCLAIMER
  157.     ----------
  158.         
  159.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  160.     held responsible for any damage incurred while operating SFLASTEN.
  161.     All responsibility lies with the user of the software.
  162.  
  163.        The documentation for SFLASTEN is contributed by Jacque
  164.     Shipley and The Mother Board BBS.  The shareware version of
  165.     SPITFIRE and other SPITFIRE utilities are available for download
  166.     from:
  167.  
  168.          Buffalo Creek's BBS              The Mother Board BBS
  169.           Mike Woltz, Sysop               Jacque Shipley, Sysop
  170.            (515) 225-8496                    (515) 986-3464
  171.     38400/19200/9600/2400/1200 Baud        9600/2400/1200 Baud
  172.